<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Vectorious: NDArray</title>
    
      <link type="text/css" rel="stylesheet" href="styles/vendor/prism-custom.css">
    
    <link type="text/css" rel="stylesheet" href="styles/styles.css">
    
    
    <style>
      :root {
      
      
        --primary-color: #0E6EB8;
      
      
        --secondary-color: #000000;
      
      
        --nav-title-size: 0;
      
      }
    </style>
    
    <style>
      .container {
        margin: 0;
      }
    </style>
</head>
<body>

<header class="layout-header">
  
  <h1>
    <a href="./index.html">
      Vectorious
    </a>
  </h1>
  <nav class="layout-nav">
    <ul><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class" title="class">C</span><span class="nav-item-name is-class"><a href="NDArray.html">NDArray</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#data">data</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#dtype">dtype</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#length">length</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#shape">shape</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#strides">strides</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#T">T</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#w">w</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#x">x</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#y">y</a></span></li><li class="nav-item"><span class="nav-item-type type-member" title="member">M</span><span class="nav-item-name is-member"><a href="NDArray.html#z">z</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#abs">abs</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#acos">acos</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#acosh">acosh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#add">add</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#angle">angle</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#asin">asin</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#asinh">asinh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#atan">atan</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#atanh">atanh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#augment">augment</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#binOp">binOp</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#cbrt">cbrt</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#ceil">ceil</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#check">check</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#combine">combine</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#copy">copy</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#cos">cos</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#cosh">cosh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#cross">cross</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#det">det</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#diagonal">diagonal</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#dot">dot</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#eig">eig</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#equals">equals</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#equidimensional">equidimensional</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#equilateral">equilateral</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#exp">exp</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#expm1">expm1</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#fill">fill</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#floor">floor</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#forEach">forEach</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#fround">fround</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#gauss">gauss</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#inv">inv</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#log">log</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#log1p">log1p</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#log2">log2</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#log10">log10</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#lu">lu</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#lu_factor">lu_factor</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#map">map</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#max">max</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#mean">mean</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#min">min</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#multiply">multiply</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#norm">norm</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#normalize">normalize</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#pow">pow</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#prod">prod</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#product">product</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#project">project</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#push">push</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#rank">rank</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#reciprocal">reciprocal</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#reduce">reduce</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#reshape">reshape</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#round">round</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#row_add">row_add</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#scale">scale</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#set">set</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#sign">sign</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#sin">sin</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#sinh">sinh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#slice">slice</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#solve">solve</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#sqrt">sqrt</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#square">square</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#subtract">subtract</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#sum">sum</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#swap">swap</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#tan">tan</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#tanh">tanh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#toArray">toArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#toString">toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#trace">trace</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#transpose">transpose</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDArray.html#trunc">trunc</a></span></li><li class="nav-heading"><span class="nav-item-type type-class" title="class">C</span><span class="nav-item-name is-class"><a href="NDIter.html">NDIter</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#current">current</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#done">done</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#next">next</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#next1d">next1d</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#next2d">next2d</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#next2d">next2d</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDIter.html#nextcontiguous">nextcontiguous</a></span></li><li class="nav-heading"><span class="nav-item-type type-class" title="class">C</span><span class="nav-item-name is-class"><a href="NDMultiIter.html">NDMultiIter</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDMultiIter.html#.current">current</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDMultiIter.html#.done">done</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="NDMultiIter.html#.next">next</a></span></li></ul><ul><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module" title="module">M</span><span class="nav-item-name is-module"><a href="module-Globals.html">Globals</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.abs">abs</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.acos">acos</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.acosh">acosh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.add">add</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.angle">angle</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.array">array</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.asin">asin</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.asinh">asinh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.atan">atan</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.atanh">atanh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.augment">augment</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.binOp">binOp</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.cbrt">cbrt</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.ceil">ceil</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.check">check</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.combine">combine</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.copy">copy</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.cos">cos</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.cosh">cosh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.cross">cross</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.det">det</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.diagonal">diagonal</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.dot">dot</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.eig">eig</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.equals">equals</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.equidimensional">equidimensional</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.equilateral">equilateral</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.exp">exp</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.expm1">expm1</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.eye">eye</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.fill">fill</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.floor">floor</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.forEach">forEach</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.fround">fround</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.gauss">gauss</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.inv">inv</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.log">log</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.log1p">log1p</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.log2">log2</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.log10">log10</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.lu">lu</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.lu_factor">lu_factor</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.magic">magic</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.map">map</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.matrix">matrix</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.max">max</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.mean">mean</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.min">min</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.multiply">multiply</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.norm">norm</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.normalize">normalize</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.ones">ones</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.pow">pow</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.prod">prod</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.product">product</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.project">project</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.push">push</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.random">random</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.range">range</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.rank">rank</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.reciprocal">reciprocal</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.reduce">reduce</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.reshape">reshape</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.round">round</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.row_add">row_add</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.scale">scale</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.set">set</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.sign">sign</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.sin">sin</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.sinh">sinh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.slice">slice</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.solve">solve</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.sqrt">sqrt</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.square">square</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.subtract">subtract</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.sum">sum</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.swap">swap</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.tan">tan</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.tanh">tanh</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.toArray">toArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.toString">toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.trace">trace</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.transpose">transpose</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.trunc">trunc</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="module-Globals.html#.zeros">zeros</a></span></li></ul>
  </nav>
</header>


<main class="layout-main ">
  <div class="container">
    <p class="page-kind">Class</p>
    <h1 class="page-title">NDArray</h1>
    




<section>


<header class="class">


    
        
        <!-- <h2>NDArray</h2> -->

        

        

        
    
</header>

<article>
    <div class="container-overview">



    
        





    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="NDArray">new NDArray<span class="signature">(data, options<span class="signature-attributes">opt</span>)</span><span class="return-type-signature"></span>
    </h4>





<div class="method-description">
    
    <p>Constructs or copies an NDArray instance.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">data</span>
            

            

            
                <span class="param-attributes">
                

                

                
                </span>
            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">options</span>
            

            
                


    <span class="param-type">
        <code>Object</code>
    </span>
    

            

            
                <span class="param-attributes">
                
                    &lt;optional&gt;<br>
                

                

                
                </span>
            

            

            <div class="param-description"></div>
            
                <p class="param-properties">Properties</p>
                

<ul class="method-params">
    

        <li>
            
                <span class="param-name">shape</span>
            

            
                


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

            

            
                <span class="param-attributes">
                
                    &lt;optional&gt;<br>
                

                

                
                </span>
            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">length</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            
                <span class="param-attributes">
                
                    &lt;optional&gt;<br>
                

                

                
                </span>
            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">strides</span>
            

            
                


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

            

            
                <span class="param-attributes">
                
                    &lt;optional&gt;<br>
                

                

                
                </span>
            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">dtype</span>
            

            
                


    <span class="param-type">
        <code>string</code>
    </span>
    

            

            
                <span class="param-attributes">
                
                    &lt;optional&gt;<br>
                

                

                
                </span>
            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>






    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { NDArray } from 'vectorious';

new NDArray() // => array([], dtype=float64)
new NDArray([]) // => array([], dtype=float64)
new NDArray([1, 2, 3]) // => array([1, 2, 3], dtype=float64)
new NDArray([[1, 2], [3, 4]]) // => array([ [ 1, 2 ], [ 3, 4 ] ], dtype=float64)
new NDArray(new Int32Array([1, 2, 3])) // => array([ 1, 2, 3 ], dtype=int32)
new NDArray([1, 2, 3, 4], {
  shape: [2, 2],
  dtype: 'uint32'
}) // => array([ [ 1, 2 ], [ 3, 4 ] ], dtype=uint32)</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.89">, line 89</a>
        </li>
    </ul>



    
    </div>

    

    

     

    

    


    
        <h3 class="subtitle">Members</h3>

        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="data">data<span class="type-signature">TypedArray</span></h4>






    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>TypedArray</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">Default Value</h4>
        <ul>
            <li>
                new Float64Array(0)
            </li>
        </ul>
    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.113">, line 113</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="dtype">dtype<span class="type-signature">String</span></h4>






    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>String</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">Default Value</h4>
        <ul>
            <li>
                'float64'
            </li>
        </ul>
    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.120">, line 120</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="length">length<span class="type-signature">Number</span></h4>






    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Number</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">Default Value</h4>
        <ul>
            <li>
                0
            </li>
        </ul>
    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.127">, line 127</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="shape">shape<span class="type-signature">Array.&lt;Number></span></h4>






    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">Default Value</h4>
        <ul>
            <li>
                [0]
            </li>
        </ul>
    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.134">, line 134</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="strides">strides<span class="type-signature">Array.&lt;Number></span></h4>






    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">Default Value</h4>
        <ul>
            <li>
                [0]
            </li>
        </ul>
    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.141">, line 141</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="T">T<span class="type-signature"><a href="NDArray.html">NDArray</a></span></h4>




<div class="description">
    <p>Short for this.copy().transpose()</p>
</div>



    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.315">, line 315</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="w">w<span class="type-signature">Number</span></h4>




<div class="description">
    <p>Gets or sets the value at index 3</p>
</div>



    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Number</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.299">, line 299</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="x">x<span class="type-signature">Number</span></h4>




<div class="description">
    <p>Gets or sets the value at index 0</p>
</div>



    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Number</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.251">, line 251</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="y">y<span class="type-signature">Number</span></h4>




<div class="description">
    <p>Gets or sets the value at index 1</p>
</div>



    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Number</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.267">, line 267</a>
        </li>
    </ul>


</article>
        
            

<article class="member">
    <div class="method-type">
        
    </div>
<h4 class="member-name" id="z">z<span class="type-signature">Number</span></h4>




<div class="description">
    <p>Gets or sets the value at index 2</p>
</div>



    <h4>Type</h4>
    <ul>
        <li>
            


    <span class="param-type">
        <code>Number</code>
    </span>
    

        </li>
    </ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>







    <h4>Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_index.js.html">core/index.js</a><a href="core_index.js.html#source.283">, line 283</a>
        </li>
    </ul>


</article>
        
    

    
        <h3 class="subtitle">Methods</h3>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="abs">abs<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the absolute value of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([-1, -2, -3]).abs() // &lt;=> array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_abs.js.html">core/abs.js</a><a href="core_abs.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="acos">acos<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the arccosine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([-1, 0, 1]).acos(); // &lt;=> array([3.141592653589793, 1.5707963267948966, 0])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_acos.js.html">core/acos.js</a><a href="core_acos.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="acosh">acosh<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the hyperbolic arccosine of each element of current array.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).acosh(); // &lt;=> array([0, 1.316957950592041, 1.7627471685409546])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_acosh.js.html">core/acosh.js</a><a href="core_acosh.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="add">add<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Adds <code>x</code> multiplied by <code>alpha</code> to the current array.
Accelerated with BLAS <code>?axpy</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).add([4, 5, 6]); // &lt;=> array([5, 7, 9])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_add.js.html">core/add.js</a><a href="core_add.js.html#source.72">, line 72</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="angle">angle<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {number}</span>
    </h4>





<div class="method-description">
    
    <p>Determines the angle between the current vector and <code>x</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).angle([4, 5, 6]); // &lt;=> 0.22572622788897287</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_angle.js.html">core/angle.js</a><a href="core_angle.js.html#source.22">, line 22</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="asin">asin<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the arcsine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([-1, 0, 1]).asin() // &lt;=> array([-1.5707963705062866, 0, 1.5707963705062866])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_asin.js.html">core/asin.js</a><a href="core_asin.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="asinh">asinh<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the hyperbolic arcsine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0, 1, 2]).asinh() // &lt;=> array([0, 0.8813735842704773, 1.4436354637145996])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_asinh.js.html">core/asinh.js</a><a href="core_asinh.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="atan">atan<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the arctangent of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).atan() // &lt;=> array([0.7853981852531433, 1.1071487665176392, 1.249045729637146])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_atan.js.html">core/atan.js</a><a href="core_atan.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="atanh">atanh<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the hyperbolic arctangent of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0, -0.5]).atanh(); // &lt;=> array([0, -0.5493061542510986])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_atanh.js.html">core/atanh.js</a><a href="core_atanh.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="augment">augment<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Augments <code>x</code> with current matrix.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 2], [3, 4]]).augment(array([[1], [2]])); // &lt;=> array([[1, 2, 1], [3, 4, 2]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_augment.js.html">core/augment.js</a><a href="core_augment.js.html#source.38">, line 38</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="binOp">binOp<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Perform binary operation <code>f</code> on <code>x</code> in the current array.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).binOp([4, 5, 6], (a, b) => a + b); // => array([[5, 7, 9])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_binOp.js.html">core/binOp.js</a><a href="core_binOp.js.html#source.47">, line 47</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="cbrt">cbrt<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the cube root of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { cbrt } from 'vectorious/core/cbrt';

cbrt([1, 8, 27]); // => array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_cbrt.js.html">core/cbrt.js</a><a href="core_cbrt.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="ceil">ceil<span class="signature">()</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Returns smallest integer greater than or equal to of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0.5, 1.5, 2.5]).ceil(); // &lt;=> array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_ceil.js.html">core/ceil.js</a><a href="core_ceil.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="check">check<span class="signature">()</span><span class="return-type-signature"></span>
    </h4>





<div class="method-description">
    
    <p>Asserts if indices <code>i, j, ..., n</code> are within the bounds of current array</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">...indices</span>
            

            
                


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>






    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0.5, 1.5, 2.5]).check(3); // Error: index out of bounds</code></pre>












<h4 class="method-heading">Throws</h4>

        

<dl>
    <dt>
        <div class="param-desc">
        <p>index out of bounds</p>
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                


    <span class="param-type">
        <code>Error</code>
    </span>
    

            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    


    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_check.js.html">core/check.js</a><a href="core_check.js.html#source.46">, line 46</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="combine">combine<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Combines the current vector with <code>x</code></p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).combine([4, 5, 6]); // => array([1, 2, 3, 4, 5, 6])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_combine.js.html">core/combine.js</a><a href="core_combine.js.html#source.22">, line 22</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="copy">copy<span class="signature">()</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Makes a copy of the class and underlying data</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">To Do</h4>
        <ul>
            <li>Should make new array C-contiguous in addition to just copying</li>
        </ul>
    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).copy(); // => array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_copy.js.html">core/copy.js</a><a href="core_copy.js.html#source.18">, line 18</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="cos">cos<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the cosine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0, Math.PI / 2, Math.PI]).cos(); // => array([1, 0, -1])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_cos.js.html">core/cos.js</a><a href="core_cos.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="cosh">cosh<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the hyperbolic cosine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0, 1, 2]).cosh(); // => array([1, 1.5430806875228882, 3.762195587158203])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_cosh.js.html">core/cosh.js</a><a href="core_cosh.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="cross">cross<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Computes the cross product of the current vector and the vector <code>x</code>
This operation can only calculated for vectors with three components.
Otherwise it throws an exception.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).cross([4, 5, 6]); // &lt;=> array([-3, 6, -3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_cross.js.html">core/cross.js</a><a href="core_cross.js.html#source.24">, line 24</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="det">det<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the determinant of current matrix using LU factorization.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[0, 1], [2, 3]]).det(); // => -2</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_det.js.html">core/det.js</a><a href="core_det.js.html#source.34">, line 34</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="diagonal">diagonal<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the diagonal of current matrix.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).diagonal(); // => array([1, 4])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_diagonal.js.html">core/diagonal.js</a><a href="core_diagonal.js.html#source.36">, line 36</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="dot">dot<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Performs dot multiplication with <code>x</code> and current array
Accelerated with BLAS <code>?dot</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).dot([4, 5, 6]); // => 32</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_dot.js.html">core/dot.js</a><a href="core_dot.js.html#source.71">, line 71</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="eig">eig<span class="signature">()</span><span class="return-type-signature"> &rarr; {Array.&lt;<a href="NDArray.html">NDArray</a>>}</span>
    </h4>





<div class="method-description">
    
    <p>Gets eigenvalues and eigenvectors of the current matrix using the Jacobi method.
Accelerated with LAPACK <code>?geev</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Array.&lt;NDArray></code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 0, 0], [0, 2, 0], [0, 0, 3]]).eig(); // => [array([1, 2, 3]), array([[1, 0, 0], [0, 1, 0], [0, 0, 1]])]</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_eig.js.html">core/eig.js</a><a href="core_eig.js.html#source.60">, line 60</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="equals">equals<span class="signature">(x, tolerance)</span><span class="return-type-signature"> &rarr; {Boolean}</span>
    </h4>





<div class="method-description">
    
    <p>Checks if current array and <code>x</code> are equal.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">tolerance</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Boolean</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { equals } from 'vectorious/core/equals';

array([1, 2, 3]).equals([1, 2, 3]); // => true</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_equals.js.html">core/equals.js</a><a href="core_equals.js.html#source.51">, line 51</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="equidimensional">equidimensional<span class="signature">(x)</span><span class="return-type-signature"></span>
    </h4>





<div class="method-description">
    
    <p>Asserts if current array and <code>x</code> have the same shape</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    
        <h4 class="method-heading">Deprecated</h4>
        
            <ul><li>Yes</li></ul>
        
    

    

    

    

    

    

    

    
</div>






    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).equidimensional([1, 2]); // Error: shapes 3 and 2 do not match</code></pre>












<h4 class="method-heading">Throws</h4>

        

<dl>
    <dt>
        <div class="param-desc">
        <p>shapes x and y do not match</p>
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                


    <span class="param-type">
        <code>Error</code>
    </span>
    

            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    


    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_equidimensional.js.html">core/equidimensional.js</a><a href="core_equidimensional.js.html#source.22">, line 22</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="equilateral">equilateral<span class="signature">(x)</span><span class="return-type-signature"></span>
    </h4>





<div class="method-description">
    
    <p>Asserts if current array and <code>x</code> have the same length</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    
        <h4 class="method-heading">Deprecated</h4>
        
            <ul><li>Yes</li></ul>
        
    

    

    

    

    

    

    

    
</div>






    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).equilateral([1, 2]); // Error: lengths 3 and 2 do not match</code></pre>












<h4 class="method-heading">Throws</h4>

        

<dl>
    <dt>
        <div class="param-desc">
        <p>lengths x and y do not match</p>
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                


    <span class="param-type">
        <code>Error</code>
    </span>
    

            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    


    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_equilateral.js.html">core/equilateral.js</a><a href="core_equilateral.js.html#source.22">, line 22</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="exp">exp<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns e^x of each element of current array, where x is the argument,
and e is Euler's constant (2.718…), the base of the natural logarithm.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).exp(); // &lt;=> array([2.7182817459106445, 7.389056205749512, 20.08553695678711])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_exp.js.html">core/exp.js</a><a href="core_exp.js.html#source.33">, line 33</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="expm1">expm1<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns subtracting 1 from exp(x) of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).expm1(); // &lt;=> array([1.7182817459106445, 6.389056205749512, 19.08553695678711])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_expm1.js.html">core/expm1.js</a><a href="core_expm1.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="fill">fill<span class="signature">(value)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Fills the current array with a scalar value</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">value</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).fill(0); // &lt;=> array([0, 0, 0])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_fill.js.html">core/fill.js</a><a href="core_fill.js.html#source.34">, line 34</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="floor">floor<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the largest integer less than or equal to a number of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1.5, 2.5, 3.5]).floor(); // &lt;=> array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_floor.js.html">core/floor.js</a><a href="core_floor.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="forEach">forEach<span class="signature">(f)</span><span class="return-type-signature"></span>
    </h4>





<div class="method-description">
    
    <p>Equivalent to <code>TypedArray.prototype.forEach</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">f</span>
            

            
                


    <span class="param-type">
        <code>function</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>






    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).forEach(console.log);
// 1 0 [ 1, 2, 3 ]
// 2 1 [ 1, 2, 3 ]
// 3 2 [ 1, 2, 3 ]</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_forEach.js.html">core/forEach.js</a><a href="core_forEach.js.html#source.34">, line 34</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="fround">fround<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the nearest single precision float representation of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([-5.05, 5.05]).fround(); // &lt;=> array([-5.050000190734863, 5.050000190734863])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_fround.js.html">core/fround.js</a><a href="core_fround.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="gauss">gauss<span class="signature">()</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Gauss-Jordan elimination (i.e. returns the reduced row echelon form) of the current matrix.
Accelerated with LAPACK <code>?getrf</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 2, 3], [4, 5, 6]]).gauss(); // &lt;=> array([[1, 0, -1], [-0, 1, 2]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_gauss.js.html">core/gauss.js</a><a href="core_gauss.js.html#source.69">, line 69</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="get">get<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the element at <code>i, j, ..., n</code> from current vector.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">...indices</span>
            

            
                


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).get(2); // 3</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_get.js.html">core/get.js</a><a href="core_get.js.html#source.46">, line 46</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="inv">inv<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Determines the inverse of current matrix using Gaussian elimination.
Accelerated with LAPACK <code>?getri</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[2, -1, 0], [-1, 2, -1], [0, -1, 2]]).inv(); // &lt;=> array([[0.75, 0.5, 0.25], [0.5, 1, 0.5], [0.25, 0.5, 0.75]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_inv.js.html">core/inv.js</a><a href="core_inv.js.html#source.71">, line 71</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="log">log<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the natural logarithm (log_e, also ln) of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).log(); // &lt;=> array([0, 0.6931471824645996, 1.0986123085021973])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_log.js.html">core/log.js</a><a href="core_log.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="log1p">log1p<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the natural logarithm (log_e, also ln) of 1 + x for each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]); // &lt;=> array([0.6931471824645996, 1.0986123085021973, 1.3862943649291992])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_log1p.js.html">core/log1p.js</a><a href="core_log1p.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="log2">log2<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the base 2 logarithm of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 4]).log2(); // => array([0, 1, 2])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_log2.js.html">core/log2.js</a><a href="core_log2.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="log10">log10<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the base 10 logarithm of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([10, 100, 1000]).log10(); // &lt;=> array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_log10.js.html">core/log10.js</a><a href="core_log10.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="lu">lu<span class="signature">()</span><span class="return-type-signature"> &rarr; {Array.&lt;(<a href="NDArray.html">NDArray</a>|Int32Array)>}</span>
    </h4>





<div class="method-description">
    
    <p>Performs full LU decomposition on current matrix.
Accelerated with LAPACK <code>?getrf</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Array.&lt;(NDArray|Int32Array)></code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 3, 5], [2, 4, 7], [1, 1, 0]]).lu(); // => [array([[1, 0, 0], [0.5, 1, 0], [0.5, -1, 1]]), array([[2, 4, 7], [0, 1, 1.5], [0, 0, -2]]), Int32Array([2, 2, 3])]</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_lu.js.html">core/lu.js</a><a href="core_lu.js.html#source.50">, line 50</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="lu_factor">lu_factor<span class="signature">()</span><span class="return-type-signature"> &rarr; {Array.&lt;(<a href="NDArray.html">NDArray</a>|Int32Array)>}</span>
    </h4>





<div class="method-description">
    
    <p>Performs LU factorization on current matrix.
Accelerated with LAPACK <code>?getrf</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Array.&lt;(NDArray|Int32Array)></code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 3, 5], [2, 4, 7], [1, 1, 0]]).lu_factor(); // &lt;=> [array([[2, 4, 7], [0.5, 1, 1.5], [0.5, -1, -2]]), Int32Array([2, 2, 3])]</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_lu_factor.js.html">core/lu_factor.js</a><a href="core_lu_factor.js.html#source.58">, line 58</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="map">map<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Equivalent to <code>TypedArray.prototype.map</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).map(value => -value); // => array([-1, -2, -3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_map.js.html">core/map.js</a><a href="core_map.js.html#source.30">, line 30</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="max">max<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the maximum value (smallest) element of current array.
Accelerated with BLAS <code>i?amax</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).max(); // => 3</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_max.js.html">core/max.js</a><a href="core_max.js.html#source.52">, line 52</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="mean">mean<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the arithmetic mean of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).mean(); // => 2</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_mean.js.html">core/mean.js</a><a href="core_mean.js.html#source.30">, line 30</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="min">min<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the minimum value (smallest) element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).min(); // 1</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_min.js.html">core/min.js</a><a href="core_min.js.html#source.30">, line 30</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="multiply">multiply<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Multiplies current matrix with <code>x</code>.
Accelerated with BLAS <code>?gemm</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 2]]).multiply([[1], [2]]); // &lt;=> array([[5]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_multiply.js.html">core/multiply.js</a><a href="core_multiply.js.html#source.72">, line 72</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="norm">norm<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Calculates the norm of current array (also called L2 norm or Euclidean length).
Accelerated with BLAS <code>?nrm2</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).norm(); // => 3.7416574954986572</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_norm.js.html">core/norm.js</a><a href="core_norm.js.html#source.41">, line 41</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="normalize">normalize<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Normalizes current vector.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).normalize(); // => array([0.26726123690605164, 0.5345224738121033, 0.8017836809158325])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_normalize.js.html">core/normalize.js</a><a href="core_normalize.js.html#source.20">, line 20</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="pow">pow<span class="signature">(exponent)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns each element of current array to the exponent power, that is, element^exponent.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">exponent</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).pow(2); // &lt;=> array([1, 4, 9])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_pow.js.html">core/pow.js</a><a href="core_pow.js.html#source.34">, line 34</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="prod">prod<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Product of all elements of current array</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).prod(); // => 6</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_prod.js.html">core/prod.js</a><a href="core_prod.js.html#source.30">, line 30</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="product">product<span class="signature">()</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Hadamard product of current matrix and <code>x</code></p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).product([4, 5, 6]); // &lt;=> array([4, 10, 18])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_product.js.html">core/product.js</a><a href="core_product.js.html#source.49">, line 49</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="project">project<span class="signature">()</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Projects the current vector onto <code>x</code> using the projection formula <code>(y * (x * y / y * y))</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).project([4, 5, 6]); // &lt;=> array([1.6623376607894897, 2.0779221057891846, 2.49350643157959])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_project.js.html">core/project.js</a><a href="core_project.js.html#source.21">, line 21</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="push">push<span class="signature">(value)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Pushes a new <code>value</code> into current vector.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">value</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).push(4); // => array([1, 2, 3, 4])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_push.js.html">core/push.js</a><a href="core_push.js.html#source.22">, line 22</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="rank">rank<span class="signature">(tolerance)</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Finds the rank of current matrix using gaussian elimination.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">tolerance</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
        <h4 class="method-heading">To Do</h4>
        <ul>
            <li>Switch to SVD algorithm</li>
        </ul>
    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 1, 1], [2, 2, 2], [3, 3, 3]]).rank(); // => 1</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_rank.js.html">core/rank.js</a><a href="core_rank.js.html#source.50">, line 50</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="reciprocal">reciprocal<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the element-wise reciprocal of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]); // => array([1, 0.5, 0.3333333432674408])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_reciprocal.js.html">core/reciprocal.js</a><a href="core_reciprocal.js.html#source.32">, line 32</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="reduce">reduce<span class="signature">(f, initialValue)</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Equivalent to <code>TypedArray.prototype.reduce</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">f</span>
            

            
                


    <span class="param-type">
        <code>function</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">initialValue</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).reduce((a, b) => a + b, 0); // => 6</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_reduce.js.html">core/reduce.js</a><a href="core_reduce.js.html#source.32">, line 32</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="reshape">reshape<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Reshapes current array</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">...shape</span>
            

            
                


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3, 4]).reshape(2, 2); // &lt;=> array([[1, 2], [3, 4]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_reshape.js.html">core/reshape.js</a><a href="core_reshape.js.html#source.47">, line 47</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="round">round<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the value of each element of current array rounded to the nearest integer.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1.2, 2.8, 3.5]).round(); // &lt;=> array([1, 3, 4])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_round.js.html">core/round.js</a><a href="core_round.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="row_add">row_add<span class="signature">(dest, source, scalar)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Adds a multiple of one row multiplied by <code>scalar</code> to another inside current matrix.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">dest</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">source</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">scalar</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 2], [3, 4]]).row_add(1, 0, 2); // &lt;=> array([[1, 2], [5, 8]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_row_add.js.html">core/row_add.js</a><a href="core_row_add.js.html#source.40">, line 40</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="scale">scale<span class="signature">(scalar)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Multiplies all elements of current array with a specified <code>scalar</code>.
Accelerated with BLAS <code>?scal</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">scalar</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).scale(2); // &lt;=> array([2, 4, 6])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_scale.js.html">core/scale.js</a><a href="core_scale.js.html#source.55">, line 55</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="set">set<span class="signature">(value)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Sets the element at <code>i, j, ..., n</code> to <code>value</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">...indices</span>
            

            
                


    <span class="param-type">
        <code>Array.&lt;Number></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">value</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).set(1, 0); // &lt;=> array([1, 0, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_set.js.html">core/set.js</a><a href="core_set.js.html#source.45">, line 45</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="sign">sign<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the sign of each element of current array, indicating
whether it is positive, negative or zero.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).sign(); // &lt;=> array([1, 1, 1])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_sign.js.html">core/sign.js</a><a href="core_sign.js.html#source.33">, line 33</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="sin">sin<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the sine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([0, Math.PI / 2, Math.PI]).sin(); // &lt;=> array([0, 1, 0])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_sin.js.html">core/sin.js</a><a href="core_sin.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="sinh">sinh<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the hyperbolic sine of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).sinh(); // &lt;=> array([1.175201177597046, 3.6268603801727295, 10.017874717712402])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_sinh.js.html">core/sinh.js</a><a href="core_sinh.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="slice">slice<span class="signature">(begin, end, step)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Slices the current array in the corresponding dimension</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">begin</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">end</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">step</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3, 4]).slice(0, 4, 2); // => array([1, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_slice.js.html">core/slice.js</a><a href="core_slice.js.html#source.44">, line 44</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="solve">solve<span class="signature">(x)</span><span class="return-type-signature"> &rarr; {<a href="NDArray.html">NDArray</a>}</span>
    </h4>





<div class="method-description">
    
    <p>Solves the equation AX = B (where A is current matrix and B is <code>x</code>).
Accelerated with LAPACK <code>?gesv</code>.</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">x</span>
            

            
                


    <span class="param-type">
        <code><a href="NDArray.html">NDArray</a></code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>NDArray</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 3, 5], [2, 4, 7], [1, 1, 0]]).solve([[1], [3], [5]]); // => array([[3.25], [1.75], [-1.5]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_solve.js.html">core/solve.js</a><a href="core_solve.js.html#source.59">, line 59</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="sqrt">sqrt<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the positive square root of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 4, 9]); // &lt;=> array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_sqrt.js.html">core/sqrt.js</a><a href="core_sqrt.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="square">square<span class="signature">()</span><span class="return-type-signature"></span>
    </h4>





<div class="method-description">
    
    <p>Asserts if current matrix is square.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>






    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).square(); // Error: matrix is not square</code></pre>












<h4 class="method-heading">Throws</h4>

        

<dl>
    <dt>
        <div class="param-desc">
        <p>matrix is not square</p>
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                


    <span class="param-type">
        <code>Error</code>
    </span>
    

            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


    


    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_square.js.html">core/square.js</a><a href="core_square.js.html#source.36">, line 36</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="subtract">subtract<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Subtracts <code>x</code> from the current array.
Accelerated with BLAS <code>?axpy</code>.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).subtract([1, 1, 1]); // &lt;=> array([0, 1, 2])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_subtract.js.html">core/subtract.js</a><a href="core_subtract.js.html#source.22">, line 22</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="sum">sum<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Sum of array elements</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).sum(); // => 6</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_sum.js.html">core/sum.js</a><a href="core_sum.js.html#source.30">, line 30</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="swap">swap<span class="signature">(i, j)</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Swaps two rows <code>i</code> and <code>j</code> in current matrix</p>
</div>









    <h4 class="method-heading">Parameters</h4>
    

<ul class="method-params">
    

        <li>
            
                <span class="param-name">i</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    

        <li>
            
                <span class="param-name">j</span>
            

            
                


    <span class="param-type">
        <code>Number</code>
    </span>
    

            

            

            

            <div class="param-description"></div>
            
        </li>

    
</ul>





<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 2], [3, 4]]); // &lt;=> array([[3, 4], [1, 2]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_swap.js.html">core/swap.js</a><a href="core_swap.js.html#source.38">, line 38</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="tan">tan<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the tangent of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).tan(); // &lt;=> array([1.5574077367782593, -2.185039758682251, -0.14254654943943024])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_tan.js.html">core/tan.js</a><a href="core_tan.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="tanh">tanh<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the hyperbolic tangent of each element of current array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).tanh(); // &lt;=> array([0.7615941762924194, 0.9640275835990906, 0.9950547814369202])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_tanh.js.html">core/tanh.js</a><a href="core_tanh.js.html#source.31">, line 31</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="toArray">toArray<span class="signature">()</span><span class="return-type-signature"> &rarr; {Array}</span>
    </h4>





<div class="method-description">
    
    <p>Converts current vector into a JavaScript array.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Array</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).toArray(); // => [1, 2, 3]</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_toArray.js.html">core/toArray.js</a><a href="core_toArray.js.html#source.38">, line 38</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="toString">toString<span class="signature">()</span><span class="return-type-signature"> &rarr; {String}</span>
    </h4>





<div class="method-description">
    
    <p>Converts current vector into a readable formatted string.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>String</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).toString(); // => '1,2,3'</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_toString.js.html">core/toString.js</a><a href="core_toString.js.html#source.19">, line 19</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="trace">trace<span class="signature">()</span><span class="return-type-signature"> &rarr; {Number}</span>
    </h4>





<div class="method-description">
    
    <p>Gets the trace of the matrix (the sum of all diagonal elements).</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>Number</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1, 2, 3]).trace(); // => 5</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_trace.js.html">core/trace.js</a><a href="core_trace.js.html#source.34">, line 34</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="transpose">transpose<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Transposes current matrix (mirror across the diagonal).</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]); // &lt;=> array([[1, 4, 7], [2, 5, 8], [3, 6, 9]])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_transpose.js.html">core/transpose.js</a><a href="core_transpose.js.html#source.20">, line 20</a>
        </li>
    </ul>



    </article>

        
            


    <article class="method">




    


    

    <div class="method-type">
    
    </div>

    <h4 class="method-name" id="trunc">trunc<span class="signature">()</span><span class="return-type-signature"> &rarr; {this}</span>
    </h4>





<div class="method-description">
    
    <p>Returns the integer part of each element of current array,
removing any fractional digits.</p>
</div>













<div class="details">
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</div>



    <h4 class="method-heading">Returns</h4>
    <ul>
    
        <li class="method-returns">
            
                <code>this</code>
            
            
        </li>
    
    </ul>




    <h4 class="method-heading">Example</h4>
    
    <pre><code class="language-js">import { array } from 'vectorious/core/array';

array([1.2, 2.8, 3.5]).trunc(); // => array([1, 2, 3])</code></pre>














    <h4 class="method-heading">Source</h4>
    <ul>
        <li class="method-source">
            <a href="core_trunc.js.html">core/trunc.js</a><a href="core_trunc.js.html#source.33">, line 33</a>
        </li>
    </ul>



    </article>

        
    

    

    
</article>

</section>




  </div>
</main>

<footer class="layout-footer">
  <div class="container">
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> on Tue Sep 15 2020 17:47:06 GMT+0200 (Central European Summer Time)
  </div>
</footer>



<script src="scripts/prism.dev.js"></script>
</body>
</html>